Android FHIR Engine Library/com.google.android.fhir.sync

Package-level declarations

Entrypoint for the Sync API: synchronizes local FHIR resources with a remote FHIR server/store.

Types

data class BackoffCriteria(val backoffPolicy: BackoffPolicy, val backoffDelay: Long, val timeUnit: TimeUnit)

The criteria for FhirSyncWorker failure retry based on androidx.work.WorkRequest.Builder.setBackoffCriteria

Contains the result of the conflict resolution. For now, Resolved is the only acceptable result and the expectation is that the client will resolve each and every conflict in-flight that may arise during the sync process. There is no way for the client application to abort or defer the conflict resolution to a later time.

ConflictResolver

fun interface ConflictResolver

Resolves conflicts between the client and remote changes in a Resource.

CurrentSyncJobStatus

sealed class CurrentSyncJobStatus

Sealed class representing different states of a synchronization operation. It combines WorkInfo.State and SyncJobStatus. Enqueued state represents WorkInfo.State.ENQUEUED where SyncJobStatus is not applicable. Running state is a combined state of WorkInfo.State.ENQUEUED and SyncJobStatus.Started or SyncJobStatus.InProgress. Succeeded state is a combined state of WorkInfo.State.SUCCEEDED and SyncJobStatus.Started or SyncJobStatus.Succeeded. Failed state is a combined state of WorkInfo.State.FAILED and SyncJobStatus.Failed. Cancelled state represents WorkInfo.State.CANCELLED where SyncJobStatus is not applicable.

DownloadWorkManager

interface DownloadWorkManager

Manages the process of downloading FHIR resources from a remote server.

FhirSyncWorker

abstract class FhirSyncWorker(appContext: Context, workerParams: WorkerParameters) : CoroutineWorker

Handles FHIR data synchronization between local database and remote server.

HttpAuthenticationMethod

sealed interface HttpAuthenticationMethod

The HTTP authentication method to be used for generating HTTP authorization header.

HttpAuthenticator

fun interface HttpAuthenticator

Provides an authorization method for the HTTP requests FHIR Engine sends to the FHIR server.

LastSyncJobStatus

sealed class LastSyncJobStatus

Sealed class representing the result of a synchronization operation. These are terminal states of the sync operation, representing Succeeded and Failed.

ParamMap

typealias ParamMap = Map<String, String>

Class that holds what type of resources we need to synchronise and what are the parameters of that type. e.g. we only want to synchronise patients that live in United States ResourceSyncParams(ResourceType.Patient, mapOf("address-country" to "United States")

PeriodicSyncConfiguration

class PeriodicSyncConfiguration(val syncConstraints: Constraints = Constraints.Builder().build(), val repeat: RepeatInterval, val retryConfiguration: RetryConfiguration? = defaultRetryConfiguration)

Configuration for period synchronisation

PeriodicSyncJobStatus

data class PeriodicSyncJobStatus(val lastSyncJobStatus: LastSyncJobStatus?, val currentSyncJobStatus: CurrentSyncJobStatus)

Data class representing the state of a periodic synchronization operation. It is a combined state of WorkInfo.State and SyncJobStatus. See CurrentSyncJobStatus and LastSyncJobStatus for more details.

RepeatInterval

data class RepeatInterval(val interval: Long, val timeUnit: TimeUnit)

Resolved

data class Resolved(val resolved: Resource) : ConflictResolutionResult

ResourceSyncException

data class ResourceSyncException(val resourceType: ResourceType, val exception: Exception)

RetryConfiguration

data class RetryConfiguration(val backoffCriteria: BackoffCriteria, val maxRetries: Int)

Configuration for synchronization retry

Sync

object Sync

SyncDataParams

object SyncDataParams

SyncJobStatus

sealed class SyncJobStatus

Sealed class representing different states of a synchronization operation. These states do not represent WorkInfo.State, whereas CurrentSyncJobStatus combines WorkInfo.State and SyncJobStatus in one-time and periodic sync. For more details, see CurrentSyncJobStatus and PeriodicSyncJobStatus.

SyncOperation

enum SyncOperation : Enum<SyncOperation>

Properties

AcceptLocalConflictResolver

val AcceptLocalConflictResolver: ConflictResolver

Accepts the local change and rejects the remote change.

AcceptRemoteConflictResolver

val AcceptRemoteConflictResolver: ConflictResolver

Accepts the remote change and rejects the local change.

defaultRetryConfiguration

val defaultRetryConfiguration: RetryConfiguration

Functions

concatParams

fun ParamMap.concatParams(): String